/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.eventmesh.connector.jdbc.source.dialect.cdc;

import org.apache.eventmesh.connector.jdbc.JdbcContext;
import org.apache.eventmesh.connector.jdbc.event.EventConsumer;
import org.apache.eventmesh.connector.jdbc.source.Engine;

/**
 * CdcEngine is a service that captures data change events.
 */
public interface CdcEngine<Context extends JdbcContext> extends Engine, AutoCloseable {

    /**
     * Stops the CDC Engine.
     */
    @Override
    void close() throws Exception;

    /**
     * Returns the name of the CDC Engine.
     *
     * @return String representing the name of the CDC Engine.
     */
    String getCdcEngineName();

    /**
     * Registers the CDC event consumer.
     *
     * @param consumer The CDC event consumer to register.
     */
    void registerCdcEventConsumer(EventConsumer consumer);

    void setContext(Context context);
}
